<?php
    /*********************************************************************************
     * Zurmo is a customer relationship management program developed by
     * Zurmo, Inc. Copyright (C) 2014 Zurmo Inc.
     *
     * Zurmo is free software; you can redistribute it and/or modify it under
     * the terms of the GNU Affero General Public License version 3 as published by the
     * Free Software Foundation with the addition of the following permission added
     * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
     * IN WHICH THE COPYRIGHT IS OWNED BY ZURMO, ZURMO DISCLAIMS THE WARRANTY
     * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
     *
     * Zurmo is distributed in the hope that it will be useful, but WITHOUT
     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
     * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
     * details.
     *
     * You should have received a copy of the GNU Affero General Public License along with
     * this program; if not, see http://www.gnu.org/licenses or write to the Free
     * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
     * 02110-1301 USA.
     *
     * You can contact Zurmo, Inc. with a mailing address at 27 North Wacker Drive
     * Suite 370 Chicago, IL 60606. or at email address contact@zurmo.com.
     *
     * The interactive user interfaces in original and modified versions
     * of this program must display Appropriate Legal Notices, as required under
     * Section 5 of the GNU Affero General Public License version 3.
     *
     * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
     * these Appropriate Legal Notices must retain the display of the Zurmo
     * logo and Zurmo copyright notice. If the display of the logo is not reasonably
     * feasible for technical reasons, the Appropriate Legal Notices must display the words
     * "Copyright Zurmo Inc. 2014. All rights reserved".
     ********************************************************************************/

    /**
     * Base element for outgoing email's recipients. Extended by to, cc, bcc
     */
    class OutgoingEmailMessageRecipientBaseElement extends MultiSelectRelatedModelsAutoCompleteElement
    {
        public $editableTemplate = '<div class="recipient">{label}<div>{content}{error}</div></div>';

        protected function getRecipientType($lowerCase = true)
        {
            $recipientType  = $this->params['recipientType'];
            $recipientType  = EmailMessageRecipient::renderNonEditableRecipientTypeStringContent($recipientType);
            if ($lowerCase)
            {
                $recipientType  = strtolower($recipientType);
            }
            return $recipientType;
        }

        protected function getRecipientTypeForId()
        {
            $recipientType  = $this->params['recipientType'];
            switch ($recipientType)
            {
                case EmailMessageRecipient::TYPE_TO:
                    $type = 'to';
                    break;
                case EmailMessageRecipient::TYPE_CC:
                    $type = 'cc';
                    break;
                case EmailMessageRecipient::TYPE_BCC:
                    $type = 'bcc';
                    break;
                default:
                    throw new NotSupportedException();
            }
            return $type;
        }

        protected function getFormName()
        {
            return get_class($this->model);
        }

        protected function assertModelType()
        {
            assert('$this->model instanceof CreateEmailMessageForm');
        }

        protected function getAttributeNameWithRecipientType()
        {
            return $this->attribute . '_' . $this->getRecipientTypeForId();
        }

        protected function getUnqualifiedIdForIdField()
        {
            return '_' . $this->getAttributeNameWithRecipientType();
        }

        protected function getUnqualifiedNameForIdField()
        {
            return "[" . $this->attribute ."][" . $this->getRecipientTypeForId() . "]"; // Not Coding Standard
        }

        protected function getWidgetSourceUrl()
        {
            return Yii::app()->createUrl('emailMessages/default/autoCompleteForMultiSelectAutoComplete');
        }

        protected function getWidgetHintText()
        {
            return Zurmo::t('EmailMessagesModule', 'Type name or email');
        }

        protected function renderLabel()
        {
            $recipientType  = $this->getRecipientType(false);
            $inputId        = $this->getEditableInputId();
            $content        = $this->form->labelEx($this->model, $this->attribute, array('for' => $inputId,
                                                                                            'label' => $recipientType));
            return $content;
        }

        /**
         * Generate the error content. Used by editable content
         * @return error content
         */
        protected function renderError()
        {
            $content = $this->form->error($this->model, $this->getAttributeNameWithRecipientType(),
                                           array('inputID' => $this->getEditableInputId()));
            return $content;
        }

        protected function getRelationName()
        {
            return 'recipients';
        }

        protected function resolveIdAndNameByModel(RedBeanModel $recipient)
        {
            if ($recipient->type == $this->params['recipientType'])
            {
                return array('id'   => $recipient->toAddress,
                                $this->getWidgetPropertyToSearch() => $recipient->toName .
                                                                            ' (' . $recipient->toAddress . ')');
            }
        }
    }
?>